Layer Definition Schema
EDITFORM Element
See Also  Send comments on this topic.
Layer Definition Schema : EDITFORM Element

Glossary Item Box

Description

Used to define an edit form in an ArcPad layer definition.

Diagram

TABLEFORM Element PICTUREPAGE Element PAGE Element Sequence EDITFORM Element

Overview

EDITFORM
Used to define an edit form in an ArcPad layer definition.
height required xs:int
Form height.
width required xs:int
Form width.
attributespagevisible optional Restriction of xs:string
Specifies whether the Attributes page should be displayed with the edit form.
backgroundcolor optional
The background color to use for the edit form. This can be overridden by setting a page's or control's backgroundcolor attribute.
caption optional xs:string
Displayed in the titlebar of the edit form.
color optional
The color to use for the edit form's text. This can be overridden by setting a page's or control's color attribute.
font optional
The font for the edit form. This can be overridden by setting a page's or control's font attribute.
fontsize optional Restriction of xs:int
The font size for the edit form. This can be overridden by setting a page's or control's fontsize attribute.
fontstyle optional Restriction of xs:string
The font style for the edit form. This can be overridden by setting a page's or control's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
geographypagevisible optional Restriction of xs:string
Specifies whether the Geography page should be displayed with the edit form.
oncancel optional
Specify the script to run when this event occurs.
onkillactive optional
Specify the script to run when this event occurs.
onload optional
Specify the script to run when this event occurs.
onok optional
Specify the script to run when this event occurs.
onrefresh optional
Specify the script to run when this event occurs.
onsetactive optional
Specify the script to run when this event occurs.
onunload optional
Specify the script to run when this event occurs.
picturepagevisible optional Restriction of xs:string
Specifies whether the Picture page should be displayed with the edit form.
sip optional Restriction of xs:string
Specifies whether the SIP (soft input panel) is displayed on pen devices by default when controls get the focus. Individual pages can override this setting with the sip attribute of the PAGE element.
symbologypagevisible optional Restriction of xs:string
Specifies whether the Symbology page should be displayed with the edit form.
tabsvisible optional Restriction of xs:string
Flag that determines if page tabs are displayed for a single page edit form.
Sequence
PAGE 1..∞
Used to define a page of an ArcPad form.
PICTUREPAGE
Used to define a picture page in a form
TABLEFORM 1..∞
Used to define additional ArcPad pages that contain tables related to the feature

Attributes

NameTypeUseDefaultFixedDescription
heightxs:intrequired  Form height.
widthxs:intrequired  Form width.
attributespagevisibleRestriction of xs:stringoptionaltrue Specifies whether the Attributes page should be displayed with the edit form.
backgroundcolor optional  The background color to use for the edit form. This can be overridden by setting a page's or control's backgroundcolor attribute.
captionxs:stringoptional  Displayed in the titlebar of the edit form.
color optional  The color to use for the edit form's text. This can be overridden by setting a page's or control's color attribute.
font optional  The font for the edit form. This can be overridden by setting a page's or control's font attribute.
fontsizeRestriction of xs:intoptional  The font size for the edit form. This can be overridden by setting a page's or control's fontsize attribute.
fontstyleRestriction of xs:stringoptionalregular The font style for the edit form. This can be overridden by setting a page's or control's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
geographypagevisibleRestriction of xs:stringoptionaltrue Specifies whether the Geography page should be displayed with the edit form.
oncancel optional  Specify the script to run when this event occurs.
onkillactive optional  Specify the script to run when this event occurs.
onload optional  Specify the script to run when this event occurs.
onok optional  Specify the script to run when this event occurs.
onrefresh optional  Specify the script to run when this event occurs.
onsetactive optional  Specify the script to run when this event occurs.
onunload optional  Specify the script to run when this event occurs.
picturepagevisibleRestriction of xs:stringoptionaltrue Specifies whether the Picture page should be displayed with the edit form.
sipRestriction of xs:stringoptionalauto Specifies whether the SIP (soft input panel) is displayed on pen devices by default when controls get the focus. Individual pages can override this setting with the sip attribute of the PAGE element.
symbologypagevisibleRestriction of xs:stringoptionaltrue Specifies whether the Symbology page should be displayed with the edit form.
tabsvisibleRestriction of xs:stringoptionaltrue Flag that determines if page tabs are displayed for a single page edit form.

Examples

Restrictions

  • geographypagevisible cannot be set to "false" when GPS averaging element is enabled in ArcPad Preferences file.

Source

<xs:element name="EDITFORM" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define an edit form in an ArcPad layer definition.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element maxOccurs="unbounded" ref="apl:PAGE" />
      <xs:element ref="apl:PICTUREPAGE" />
      <xs:element maxOccurs="unbounded" ref="apl:TABLEFORM" />
    </xs:sequence>
    <xs:attribute use="required" name="height" type="xs:int">
      <xs:annotation>
        <xs:documentation>Form height.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="width" type="xs:int">
      <xs:annotation>
        <xs:documentation>Form width.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="true" name="attributespagevisible">
      <xs:annotation>
        <xs:documentation>Specifies whether the Attributes page should be displayed with the edit form.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the edit form. This can be overridden by setting a page's or control's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="caption" type="xs:string">
      <xs:annotation>
        <xs:documentation>Displayed in the titlebar of the edit form.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="color">
      <xs:annotation>
        <xs:documentation>The color to use for the edit form's text. This can be overridden by setting a page's or control's color attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="font">
      <xs:annotation>
        <xs:documentation>The font for the edit form. This can be overridden by setting a page's or control's font attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="fontsize">
      <xs:annotation>
        <xs:documentation>The font size for the edit form. This can be overridden by setting a page's or control's fontsize attribute.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="regular" name="fontstyle">
      <xs:annotation>
        <xs:documentation>The font style for the edit form. This can be overridden by setting a page's or control's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="regular" />
          <xs:enumeration value="bold" />
          <xs:enumeration value="italic" />
          <xs:enumeration value="underline" />
          <xs:enumeration value="strikeout" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="true" name="geographypagevisible">
      <xs:annotation>
        <xs:documentation>Specifies whether the Geography page should be displayed with the edit form.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="" name="oncancel">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onkillactive">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onload">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onok">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onrefresh">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onsetactive">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onunload">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="true" name="picturepagevisible">
      <xs:annotation>
        <xs:documentation>Specifies whether the Picture page should be displayed with the edit form.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="auto" name="sip">
      <xs:annotation>
        <xs:documentation>Specifies whether the SIP (soft input panel) is displayed on pen devices by default when controls get the focus. Individual pages can override this setting with the sip attribute of the PAGE element.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="alse" />
          <xs:enumeration value="auto" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="true" name="symbologypagevisible">
      <xs:annotation>
        <xs:documentation>Specifies whether the Symbology page should be displayed with the edit form.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="true" name="tabsvisible">
      <xs:annotation>
        <xs:documentation>Flag that determines if page tabs are displayed for a single page edit form.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2013 All Rights Reserved.